.\" Copyright (c) 2010\-2014 Plowshare Team
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 3 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, see
.\" <http://www.gnu.org/licenses/>.

.TH "plowdel" "1" "March 23, 2014" "GPL" "Plowshare for Bash 4"

.SH NAME
plowdel \- Delete files from file sharing websites links

.SH SYNOPSIS
.B plowdel
[\fIOPTIONS\fP]...
[\fIMODULE_OPTIONS\fP]...
\fIURL\fP...

.SH DESCRIPTION
.B plowdel
is a command-line tool designed for deleting files on file-sharing websites.
It acts like a web browser, retrieving pages and filling HTML forms.

Currently supported hosting sites list is available in README file.

Some sites may require authentication (login) for deleting files. See specific module options below.
Login process may sometimes require captcha solving.

.\" ****************************************************************************
.\" * Options                                                                  *
.\" ****************************************************************************
.SH OPTIONS

.SS Common options
.TP
.BI -i, " " --interface= IFACE
If your machine has several network interfaces, force using \fIIFACE\fR interface.
.SS Captcha options
.TP
.BI "   " " " --9kweu= KEY
Use 9kw.eu service to solve captchas.
.TP
.BI "   " " " --antigate= KEY
Use Antigate.com service to solve captchas.
.TP
.BI "   " " " --captchabhood= USER:PASSWORD
Use Captcha Brotherhood service to solve captchas.
.TP
.BI "   " " " --deathbycaptcha= USER:PASSWORD
Use Death by Captcha service to solve captchas.
.TP
.BI "   " " " --captchamethod= METHOD
Force specific captcha solving method. Available values:
.RS
\fBimgur\fR : upload image to Imgur.com service, print image url in console and prompt for manual entering. Useful for NAS and embedded devices.
.RE
.RS
\fBnone\fR : abort if captcha solving is requested (even if automatic solving service is available).
.RE
.RS
\fBonline\fR : use captcha solving website only (9kweu, Antigate, CaptchaBrotherhood or DeathByCaptcha account required).
.RE
.RS
\fBfb\fR : display image in framebuffer console and prompt for manual entering. Looks for framebuffer viewers: fbi, fim.
\fIFRAMEBUFFER\fR environment variable can contain device file. Default is \fI/dev/fb0\fR.
.RE
.RS
\fBnox\fR : display image in console (text) and prompt for manual entering. Looks for ascii viewers: img2txt, aview, tiv.
.RE
.RS
\fBx11\fR : display image in an X11 window and prompt for manual entering. Looks for viewers: display, feh, sxiv, qiv.
.RE
.TP
.BI "   " " " --captchaprogram= PROGRAM
Call external program or script for solving captchas. Provided executable can be located in PATH environment variable.

Three arguments are given:
.RS
\fB$1\fR
module name (lowercase). For example: \fImediafire\fR.
.RE
.RS
\fB$2\fR
image filename (with full path).
.RE
.RS
\fB$3\fR
hint or captcha type (string). For example: \fIrecaptcha\fR, \fIsolvemedia\fR or \fIdigits-4\fR.

Return value (on stdout) and exit status:
.RE
.RS
\fB0\fR : solving success. Captcha Word(s) must be echo'ed.
.RE
.RS
\fB2\fR : external solver is not able to solve requested captcha. Let plowdel continue solving it normally (will consider \fB--captchamethod\fR if specified).
.RE
.RS
\fB7\fR : external solver failed.

Note: plowdel legacy exit errors can also be returned, for example: \fB1\fR (fatal) or \fB3\fR (network).
.RE
.SS Logging options
.TP
.BI -v, " " --verbose= LEVEL
Set output verbosity level:
.RS 
\fB0\fR  none,
.RE
.RS 
\fB1\fR  errors,
.RE
.RS
\fB2\fR  notice (default behavior),
.RE
.RS
\fB3\fR  debug,
.RE
.RS
\fB4\fR  report (very noisy, log HTML pages).
.RE
.TP
.B -q, --quiet
Alias for \fB-v0\fR. Do not print any debug messages.
.SS Miscellaneous options
.TP
.B "   " --no-plowsharerc
Do not consider any configuration file.
.TP
.BI "   " " " --plowsharerc= FILE
Force using an alternate configuration file (instead of per-user or systemwide plowshare.conf).
This option has no effect when
.B --no-plowsharerc
is defined.
.TP
.B "   " --modules
Display all supported module names (one per line) and exit. Useful for wrappers.
.SS Generic program information
.TP
.B -h, --help
Display main help and exit.
.TP
.B -H, --longhelp
Display complete help (with module options) and exit.
.TP
.B "   " --version
Output version information and exit.

.\" ****************************************************************************
.\" * Modules options                                                          *
.\" ****************************************************************************
.SH "MODULE OPTIONS"

.SS Common options
.TP
.BI -a, " " --auth= "USER:PASSWORD"
Use premium account. Free account can be used sometimes.
.P
All switches are not implemented nor required for all modules.
See help message for detailed modules option list.

.\" ****************************************************************************
.\" * Examples                                                                 *
.\" ****************************************************************************
.SH EXAMPLES

.SS 1) Delete one or several files (using delete link)
.EX
$ plowdel http://d01.megashares.com/?dl=6EUeDtS
.sp 1
# Deletes are successive (not parallel)
$ plowdel http://d01.megashares.com/?dl=6EUeDtS \\
    http://depositfiles.com/rmv/1643181821669253
.EE

.\" ****************************************************************************
.\" * Files                                                                    *
.\" ****************************************************************************
.SH "FILES"
.TP
.I ~/.config/plowshare/plowshare.conf
This is the per-user configuration file. 
.TP
.I /etc/plowshare.conf
Systemwide configuration file.
.PP
The file format is described in
.BR plowshare.conf (5).

.\" ****************************************************************************
.\" * Exit codes                                                               *
.\" ****************************************************************************
.SH "EXIT CODES"

Possible exit codes are:
.IP 0
Success. File was successfully deleted.
.IP 1
Fatal error. Upstream site updated or unexpected result.
.IP 2
No available module (provided URL is not supported).
.IP 3
Network error. Mostly curl related.
.IP 4
Authentication failed (bad login/password).
.IP 11
Link requires an admin or removal code.
.IP 12
Authentication required (anonymous users can't delete files).
.IP 13
Link is dead. File has been previously deleted.
.IP 15
Unknown command line parameter or incompatible options.
.PP
If
.B plowdel
is invoked with multiple links and one or several errors occur, the first error code is returned added with 100.

.\" ****************************************************************************
.\" * Authors / See Also                                                       *
.\" ****************************************************************************
.SH AUTHORS
Plowshare was initially written by Arnau Sanchez. See the AUTHORS file for a list of some of the many other contributors.

Plowshare is (C) 2010-2014 The Plowshare Team
.SH "SEE ALSO"
.BR plowdown (1),
.BR plowup (1),
.BR plowlist (1),
.BR plowprobe (1),
.BR plowshare.conf (5).
